/// <license>
/// Copyright (c) 2002-2008, DotNetNuke Corporation
/// All rights reserved
///
/// Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated 
/// documentation files (the "Software"), to deal in the Software without restriction, including without limitation 
/// the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and 
/// to permit persons to whom the Software is furnished to do so, subject to the following conditions:
///
/// The above copyright notice and this permission notice shall be included in all copies or substantial portions 
/// of the Software.
///
/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED 
/// TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 
/// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF 
/// CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 
/// DEALINGS IN THE SOFTWARE.
/// </license>

#region Using Statements

using System;
using System.Collections.Generic;
using System.Text; 

#endregion

namespace DotNetNuke.ModuleToolkit.Localization
{
    /// -----------------------------------------------------------------------------
    /// <summary>
    /// Provides an interface to a service that can localize strings
    /// </summary>
    /// <history>
    ///     [anurse]    05/04/2006  created
    /// </history>
    /// -----------------------------------------------------------------------------
    public interface ILocalizationService
    {
        /// -----------------------------------------------------------------------------
        /// <summary>
        /// Localizes the specified string
        /// </summary>
        /// <param name="defaultValue">The value to return if the data could not be localized</param>
        /// <param name="key">The string to localize</param>
        /// <param name="useGlobalResources">A boolean specifying if global or local resources are to be used</param>
        /// <history>
        ///     [anurse]  05/04/2006  created
        ///     [anurse]  05/16/2006  added useGlobalResources parameter
        /// </history>
        /// -----------------------------------------------------------------------------
        string LocalizeString(string key, string defaultValue, bool useGlobalResources);
    }
}
